package com.psytech.app.task.web_ui;

/**
 * Object that embed the necessary informations about a user for the use of
 * Taskman.
 * 
 * @author ben
 * 
 */
public class User {

	private String login;
	private String email;
	private String uid;

	/**
	 * Get the login.</br> It's the human readable user id.</br>
	 * 
	 * @return the user login
	 */
	public String getLogin() {
		return this.login;
	}

	/**
	 * Set the user login.</br>
	 * 
	 * @param login
	 *            the user login
	 */
	public void setLogin(final String login) {
		this.login = login;
	}

	/**
	 * Get the user email.</br> The mail is used by Taskman to notify the user
	 * when a change affected a related task.
	 * 
	 * @see User#setEmail(String)
	 * @return the user mail
	 */
	public String getEmail() {
		return this.email;
	}

	/**
	 * Set the user email.
	 * 
	 * @param email
	 *            the user email
	 * 
	 * @see User#getEmail()
	 */
	public void setEmail(final String email) {
		this.email = email;
	}

	/**
	 * Get the user id.<br>
	 * This is the unique identifier of the user.</br>
	 * 
	 * @return the user id
	 * 
	 * @see User#setUid(String)
	 */
	public String getUid() {
		return this.uid;
	}

	/**
	 * Set the user id.</br>
	 * 
	 * @param uid
	 *            the user id
	 */
	public void setUid(final String uid) {
		this.uid = uid;
	}

}
